json doc generator now generates _index.json as it creates files. #3696

iapain · 2012-07-12T12:12:49Z

generate.js now accepts --output=<file> which tools/doc/json.js uses to write the output. If output file is missing then it executes callback. This was required to get the directory for new _index.json. Ideally, I left it for you to decide what to call this _index.json. There is already an index.json file which should not be generated at all. Additionally it sets title as first heading node text if applicable.

TODO

~~Add exclude files to avoid generation of index.json~~
Dependency map in Makefile (if subchapters like structure is required).

json doc generator now accepts output file as well. json doc generator now generates index file automatically.

iapain · 2012-07-12T12:27:16Z

Damn I cannot attach it to the issue. It's for #3668

mainerror · 2012-07-30T19:30:43Z

What's up with this pull request? Is it going to get merged?

iapain · 2012-07-31T10:28:13Z

It still needs some API related decisions from @isaacs. He urged me to write this patch but probably too busy with other stuff.

mainerror · 2012-07-31T10:51:29Z

I reckoned, just wanted to bump this a little.

isaacs · 2012-10-03T16:55:05Z

The index should be written to index.json, not _index.json.

Also, it's a bit odd having url be a an object. Maybe it should be just html: 'foo.html', json: 'foo.json' or something?

… url.json to html and json

iapain · 2012-10-03T19:37:41Z

@isaacs The reason I kept _index.json was index.markdown translates into index.json but I guess it's no longer required. In last commit I have renamed it to index.json. Moreover url.html, url.json is now just html, json as you suggested.

Nodejs-Jenkins · 2013-03-13T23:27:56Z

Can one of the admins verify this patch?

mainerror · 2013-03-14T10:54:26Z

Indeed, it would be awesome to get this in, I don't quite understand what's taking eight months to review ...

bnoordhuis · 2013-03-14T12:49:40Z

Yeah, because we're all just twiddling our thumbs while raking in the big paychecks...

Look at the number of open issues and pull requests, now realize that there are only two or three people working on node.js full time.

If you want to do something constructive, start triaging bug reports and reviewing PRs.

mainerror · 2013-03-14T17:53:55Z

@bnoordhuis I didn't say that you guys weren't doing something but eight months for such a minor PR?

I'm not actively working on Node.js, I have other projects I'm actively contributing to.

iapain · 2013-03-14T18:03:48Z

I must agree with @mainerror being a contributor it's very discouraging. I tried to bring it up few times on IRC to @isaacs in vain.

@bnoordhuis I totally respect what you guys are doing it's pretty cool and cutting edge but eventually it's core team who needs to organize and expand if it's required.

isaacs · 2013-03-14T19:39:11Z

tools/doc/json.js

@@ -146,9 +159,62 @@ function doJSON(input, filename, cb) {
    finishSection(current, stack[stack.length - 1]);
  }

-  return cb(null, root)
+  if (outfile) {
+    writeOututToFile(root, filename, outfile, indexfile, writeToIndexFile);


Typo? Should this be writeOutputToFile?

Sorry that's a typo. Will rectify in next commit.

isaacs · 2013-03-14T19:41:54Z

In general, it is better to light candles than to curse darkness. @mainerror, if you have comments on this patch, then share them. We welcome reviews from all parties. Though it does take some core team member to actually land it, you can help things along by providing feedback.

@iapain I'm a bit confused about what happens if just one of the files changes. Ie, if you've generated the index.json, and then we change doc/api/url.markdown, for instance. Will it generate a new index.json containing all of the previous files as well? How does it know to do index.json last?

iapain · 2013-03-14T20:00:55Z

@isaacs I'm not tracking anything, it just regenerates index.json. Should it keep track for changes?

…ymore.

iapain · 2013-03-14T20:28:33Z

@isaacs changes checked-in. I think now I got it what you were trying to say in previous comment. Actually writeToIndexFile checks if there is already an index.json file. It also check (in a way) that if it's proper index.json and then it update or create proper chapter entry into main json object which is written back to index.json

The current implementation uses the arguments object in the Server() constructor. Since both arguments to Server() are optional, there was a high likelihood of accessing a non-existent element in arguments, which carries a performance overhead. This commit replaces the arguments object with named arguments. Reviewed-by: Trevor Norris <trev.norris@gmail.com>

Reviewed-by: Trevor Norris <trev.norris@gmail.com> Reviewed-by: Chris Dickinson <christopher.s.dickinson@gmail.com>

chrisdickinson · 2014-11-19T21:48:20Z

tools/doc/json.js

@@ -146,9 +159,64 @@ function doJSON(input, filename, cb) {
    finishSection(current, stack[stack.length - 1]);
  }

-  return cb(null, root)
+  if (outfile) {
+    writeOutputToFile(root, filename, outfile, indexfile, writeToIndexFile);


Okay, I see the source of my confusion. writeToIndexFile performs async actions, but never calls cb. This probably needs to be something like the following:

writeOutputToFile(root, filename, outfile, indexfile, function(err, root, sourcefile, outfile) { if (err) return cb(err); writeToIndexFile(root, sourcefile, outfile, cb); })

'.' and '..' are directory specs and resolving urls with or without the hostname with '.' and '..' should add a trailing slash to the end of the url. Fixes nodejs#8992. Reviewed-By: Colin Ihrig <cjihrig@gmail.com> PR-URL: nodejs#9427

Conflicts: src/node_version.h

Port of io.js commit: nodejs/node@77f3586 Original commit message: This updates the default cipher suite to an more secure list, which prefers strong ciphers with Forward Secrecy. Additionally, it enables `honorCipherOrder` by default. Noteable effect of this change is that the insecure RC4 ciphers are disabled and that Chrome negotiates a more secure ECDHE cipher. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

Add command line switches and environment variables to override the default cipher suite in tls.js `--cipher-list` and `NODE_CIPHER_LIST` can be used to completely override the default cipher list with a given value. `--enable-legacy-cipher-list` and `NODE_LEGACY_CIPHER_LIST` can be used to reset the default cipher list back to a known legacy value shipped in prior Node.js releases A new `getLegacyCiphers` method on the tis module allows programmatic access to the old cipher list defaults. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

Based on commit feedback, make the PrintHelp for --enable-legacy-cipher-list less verbose. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

Per the commit feedback, fix up style nits and pass in the isolate with the NODE_DEFINE_STRING_CONSTANT macro. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

typo and unnecessary options init Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

Conflicts: src/node_version.h

Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25274

jasnell · 2015-06-01T23:28:44Z

@iapain @chrisdickinson ... I know it's been a while, but is this still something you want to pursue? If yes, the PR would need to be updated significantly. If not, we should likely go ahead and close.

Fixes: nodejs#5317 Improve the example in the documentation to show that response content can be chunked across multiple `data` events. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25352

Fix misspelling of 'response' on line 453 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25472

iapain · 2015-06-04T10:19:12Z

@jasnell I will implement @chrisdickinson suggestions in neat way. Hold on.

jasnell · 2015-06-04T13:08:59Z

@iapain 👍

Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25341

Conflicts: doc/api/tls.markdown src/node_version.h

You must consume the data from the response object. nodejs#8443 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25471

Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25453

The third sentence of the fifth paragraph of the documentation for transform._transform() has several words omitted and makes no sense. This fix fills in the missing words to clarify the passage. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25371

json doc generator now accepts output file as well. json doc generator now generates index file automatically.

… url.json to html and json

…ymore.

iapain · 2015-06-18T11:56:17Z

@jasnell Ready to review.

iapain · 2015-06-18T11:58:55Z

@jasnell I've to close this PR and will send you another one shortly. Looks like git rebase messed up with previous commits.

Added output file option to gentest.

5152bf5

json doc generator now accepts output file as well. json doc generator now generates index file automatically.

iapain closed this Jul 12, 2012

iapain reopened this Jul 12, 2012

Now json doc generator writes index.json file.\n Renamed url.html and…

24b1c2a

… url.json to html and json

isaacs reviewed Mar 14, 2013
View reviewed changes

Fixed some typos. writeOutputToFile does not raise and exception an…

64c39ba

…ymore.

iapain and others added 6 commits March 14, 2013 21:48

Merge branch 'master' into newdoc

a5544bd

node: Now working on v0.13.0

92598e8

Merge remote-tracking branch 'upstream/v0.12'

912b5e0

Merge remote-tracking branch 'upstream/v0.12'

7c04197

stream: remove duplicated expression

cfcb1de

Reviewed-by: Trevor Norris <trev.norris@gmail.com> Reviewed-by: Chris Dickinson <christopher.s.dickinson@gmail.com>

chrisdickinson reviewed Nov 19, 2014
View reviewed changes

Julien Gilli and others added 11 commits March 16, 2015 15:55

Merge remote-tracking branch 'upstream/v0.12'

ae58fc4

url: resolve urls with . and ..

9b534e2

'.' and '..' are directory specs and resolving urls with or without the hostname with '.' and '..' should add a trailing slash to the end of the url. Fixes nodejs#8992. Reviewed-By: Colin Ihrig <cjihrig@gmail.com> PR-URL: nodejs#9427

Merge remote-tracking branch 'upstream/v0.12'

9010dd2

Conflicts: src/node_version.h

Merge remote-tracking branch 'upstream/v0.12'

94beb29

Conflicts: src/node_version.h

tls: make --enable-legacy-cipher-list less verbose

3f58ce6

Based on commit feedback, make the PrintHelp for --enable-legacy-cipher-list less verbose. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

tls: pass in isolate with define string constant + style nits

3705736

Per the commit feedback, fix up style nits and pass in the isolate with the NODE_DEFINE_STRING_CONSTANT macro. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

test: fixing a few nits in the test

4d9c81b

typo and unnecessary options init Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#14383

Merge remote-tracking branch 'upstream/v0.12'

0df5e1c

Conflicts: src/node_version.h

src: fix ifdef comment

d13d7f7

Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25274

jasnell and others added 2 commits June 3, 2015 22:34

doc: improve http.request example

6f9b178

Fixes: nodejs#5317 Improve the example in the documentation to show that response content can be chunked across multiple `data` events. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25352

_http_server.js: fix typo in comment

016ff77

Fix misspelling of 'response' on line 453 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25472

socketpair and others added 10 commits June 4, 2015 09:31

tls.createSecurePair(): fix documentation typo

4d3514f

Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25341

Merge remote-tracking branch 'upstream/v0.12'

f9d783a

Conflicts: doc/api/tls.markdown src/node_version.h

Fix improper sample code in http.markdown

6671efa

You must consume the data from the response object. nodejs#8443 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25471

fixed a typo: fs.ReadStream(filename) -> fs.createReadStream(filename)

8c262dd

Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25453

Added output file option to gentest.

63b3f9e

json doc generator now accepts output file as well. json doc generator now generates index file automatically.

Now json doc generator writes index.json file.\n Renamed url.html and…

ab03aec

… url.json to html and json

Fixed some typos. writeOutputToFile does not raise and exception an…

428bea0

…ymore.

Callback is properly propagated thanks to @chrisdickinson

02cfad5

resolved conflicts

27b3909

iapain closed this Jun 18, 2015

iapain mentioned this pull request Jun 18, 2015

json doc generator now generates index.json as it creates files. #25540

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

json doc generator now generates _index.json as it creates files. #3696

json doc generator now generates _index.json as it creates files. #3696

iapain commented Jul 12, 2012

iapain commented Jul 12, 2012

mainerror commented Jul 30, 2012

iapain commented Jul 31, 2012

mainerror commented Jul 31, 2012

isaacs commented Oct 3, 2012

iapain commented Oct 3, 2012

Nodejs-Jenkins commented Mar 13, 2013

mainerror commented Mar 14, 2013

bnoordhuis commented Mar 14, 2013

mainerror commented Mar 14, 2013

iapain commented Mar 14, 2013

isaacs Mar 14, 2013

iapain Mar 14, 2013

isaacs commented Mar 14, 2013

iapain commented Mar 14, 2013

iapain commented Mar 14, 2013

chrisdickinson Nov 19, 2014

jasnell commented Jun 1, 2015

iapain commented Jun 4, 2015

jasnell commented Jun 4, 2015

iapain commented Jun 18, 2015

iapain commented Jun 18, 2015

json doc generator now generates _index.json as it creates files. #3696

json doc generator now generates _index.json as it creates files. #3696

Conversation

iapain commented Jul 12, 2012

iapain commented Jul 12, 2012

mainerror commented Jul 30, 2012

iapain commented Jul 31, 2012

mainerror commented Jul 31, 2012

isaacs commented Oct 3, 2012

iapain commented Oct 3, 2012

Nodejs-Jenkins commented Mar 13, 2013

mainerror commented Mar 14, 2013

bnoordhuis commented Mar 14, 2013

mainerror commented Mar 14, 2013

iapain commented Mar 14, 2013

isaacs Mar 14, 2013

Choose a reason for hiding this comment

iapain Mar 14, 2013

Choose a reason for hiding this comment

isaacs commented Mar 14, 2013

iapain commented Mar 14, 2013

iapain commented Mar 14, 2013

chrisdickinson Nov 19, 2014

Choose a reason for hiding this comment

jasnell commented Jun 1, 2015

iapain commented Jun 4, 2015

jasnell commented Jun 4, 2015

iapain commented Jun 18, 2015

iapain commented Jun 18, 2015